Maven 总结

Maven 是什么？

Maven 是一个项目管理和整合工具。Maven 为开发者提供了一套完整的构建生命周期框架。开发团队几乎不用花多少时间就能够自动完成工程的基础构建配置，因为 Maven 使用了一个标准的目录结构和一个默认的构建生命周期。

在有多个开发团队环境的情况下，Maven 能够在很短的时间内使得每项工作都按照标准进行。因为大部分的工程配置操作都非常简单并且可复用，在创建报告、检查、构建和测试自动配置时，Maven 可以让开发者的工作变得更简单。

Maven 能够帮助开发者完成以下工作：构建，文档生成，报告，依赖，SCMs，发布，分发，邮件列表。

总的来说，Maven 简化了工程的构建过程，并对其标准化。它无缝衔接了编译、发布、文档生成、团队合作和其他任务。Maven 提高了重用性，负责了大部分构建相关的任务。

pom

POM 代表工程对象模型。它是使用 Maven 工作时的基本组建，是一个 xml 文件。它被放在工程根目录下，文件命名为 pom.xml。POM 包含了关于工程和各种配置细节的信息，Maven 使用这些信息构建工程。所有的 POM 文件需要 project 元素和三个必须的字段：groupId, artifactId,version。在仓库中的工程标识为 groupId:artifactId:version

groupid代表工程组的标识，一个组织中唯一。artifactid是工程的标识，通常是工程的名称。version 是工程的版本号。

构建生命周期

构建生命周期是一组阶段的序列（sequence of phases），每个阶段定义了目标被执行的顺序。这里的阶段是生命周期的一部分。举例说明，一个典型的 Maven 构建生命周期是由以下几个阶段的序列组成的。

  • 验证（validate） - 验证项目是否正确，所有必要的信息可用
  • 编译（compile） - 编译项目的源代码
  • 测试（test） - 使用合适的单元测试框架测试编译的源代码。这些测试不应该要求代码被打包或部署
  • 打包（package） - 采用编译的代码，并以其可分配格式（如JAR）进行打包。
  • 验证（verify） - 对集成测试的结果执行任何检查，以确保满足质量标准
  • 安装（install） - 将软件包安装到本地存储库中，用作本地其他项目的依赖项
  • 部署（deploy） - 在构建环境中完成，将最终的包复制到远程存储库以与其他开发人员和项目共享。

仓库

在 Maven 的术语中，仓库是一个位置（place），例如目录，可以存储所有的工程 jar 文件、library jar 文件、插件或任何其他的工程指定的文件。Maven 仓库有三种类型：本地(local),中央(central),远程(remote)

本地仓库

Maven 本地仓库是机器上的一个文件夹。它在你第一次运行任何 maven 命令的时候创建。

Maven 本地仓库保存你的工程的所有依赖（library jar、plugin jar 等）。当你运行一次 Maven 构建，Maven 会自动下载所有依赖的 jar 文件到本地仓库中。它避免了每次构建时都引用存放在远程机器上的依赖文件。Maven 本地仓库默认被创建在 %USER_HOME% 目录下。要修改默认位置，在 %M2_HOME%\conf 目录中的 Maven 的 settings.xml 文件中定义另一个路径。

中央仓库

Maven 中央仓库是由 Maven 社区提供的仓库，其中包含了大量常用的库。中央仓库的关键概念：这个仓库由 Maven 社区管理。不需要配置。需要通过网络才能访问。

远程仓库

如果 Maven 在中央仓库中也找不到依赖的库文件，它会停止构建过程并输出错误信息到控制台。为避免这种情况，Maven 提供了远程仓库的概念，它是开发人员自己定制仓库，包含了所需要的代码库或者其他工程中用到的 jar 文件。

Maven的搜索顺序

当我们执行 Maven 构建命令时，Maven 开始按照以下顺序查找依赖的库：

  • 步骤 1 － 在本地仓库中搜索，如果找不到，执行步骤 2，如果找到了则执行其他操作。
  • 步骤 2 － 在中央仓库中搜索，如果找不到，并且有一个或多个远程仓库已经设置，则执行步骤 4，如果找到了则下载到本地仓库中已被将来引用。
  • 步骤 3 － 如果远程仓库没有被设置，Maven 将简单的停滞处理并抛出错误（无法找到依赖的文件）。
  • 步骤 4 － 在一个或多个远程仓库中搜索依赖的文件，如果找到则下载到本地仓库已被将来引用，否则 Maven 将停止处理并抛出错误（无法找到依赖的文件）。

Maven插件

Maven 实际上是一个依赖插件执行的框架，每个任务实际上是由插件完成。Maven 插件通常被用来：

  • 创建 jar 文件
  • 创建 war 文件
  • 编译代码文件
  • 代码单元测试
  • 创建工程文档
  • 创建工程报告

插件通常提供了一个目标的集合，并且可以使用下面的语法执行：

1
2
3
4
5
mvn [plugin-name]:[goal-name]
# 执行“plugin-name”插件的“goal-name”目标（或者称为动作）
#用户可以通过两种方式调用Maven插件目标。
#第一种方式是将插件目标与生命周期阶段（lifecycle phase）绑定，这样用户在命令行只是输入生命周期阶段而已，例如Maven默认将maven-compiler-plugin的compile目标与compile生命周期阶段绑定，因此命令mvn compile实际上是先定位到compile这一生命周期阶段，然后再根据绑定关系调用maven-compiler-plugin的compile目标。
#第二种方式是直接在命令行指定要执行的插件目标，例如mvnarchetype:generate 就表示调用maven-archetype-plugin的generate目标，这种带冒号的调用方式与生命周期无关。
插件 描述
clean 构建之后清理目标文件。删除目标目录。
compiler 编译 Java 源文件。
surefile 运行 JUnit 单元测试。创建测试报告。
jar(package) 从当前工程中构建 JAR 文件。
war 从当前工程中构建 WAR 文件。
javadoc 为工程生成 Javadoc。
antrun 从构建过程的任意一个阶段中运行一个 ant 任务的集合。
Maven命令列表
mvn –version 显示版本信息
mvn clean 清理项目生产的临时文件,一般是模块下的target目录
mvn compile 编译源代码，一般编译模块下的src/main/java目录
mvn package 项目打包工具,会在模块下的target目录生成jar或war等文件
mvn test 测试命令,或执行src/test/java/下junit的测试用例.
mvn install 将打包的jar/war文件复制到你的本地仓库中,供其他模块使用
mvn deploy 将打包的文件发布到远程参考,提供其他人员进行下载依赖
mvn site 生成项目相关信息的网站
mvn eclipse:eclipse 将项目转化为Eclipse项目
mvn dependency:tree 打印出项目的整个依赖树
mvn archetype:generate 创建Maven的普通java项目
mvn tomcat:run 在tomcat容器中运行web应用
mvn jetty:run 调用 Jetty 插件的 Run 目标在 Jetty Servlet 容器中启动 web 应用

Maven创建工程

Maven 使用原型（archetype）插件创建工程。要创建一个简单的 Java 应用，我们将使用 maven-archetype-quickstart 插件。在下面的例子中，将在 \MVN 文件夹下创建一个基于 maven 的 java 应用工程。打开命令控制台，跳转到 \MVN 目录，并执行下面的 mvn 命令。

1
2
3
4
5
 \MVN>mvn archetype:generate
-DgroupId=com.companyname.bank 
-DartifactId=consumerBanking 
-DarchetypeArtifactId=maven-archetype-quickstart 
-DinteractiveMode=false

Maven构建&测试工程

打开命令控制台，跳转到 \MVN\consumerBanking 目录下，并执行以下 mvn 命令。

1
\MVN\consumerBanking>mvn clean package #package的作用是打包

Maven 将开始构建工程。

已经构建了你的工程并创建了最终的 jar 文件，下面是要学习的关键概念：

  • 我们给了 maven 两个目标，首先清理目标目录（clean），然后打包工程构建的输出为 jar（package）文件。
  • 打包好的 jar 文件可以在 demo\target中获得，名称为 demo-1.0-SNAPSHOT.jar。
  • 测试报告存放在 demo\target\surefire-reports 文件夹中。
  • Maven 编译源码文件，以及测试源码文件。
  • 接着 Maven 运行测试用例。
  • 最后Maven创建工程包。

编译工程

当添加了一个文件后，可以输入下面的命令重新编译文件。

1
mvn clean compile

Maven中添加外部依赖

当远程仓库和中央仓库中都没有相关依赖时，可以手动添加jar包。

1
2
3
4
5
6
7
<dependency>
             <groupId>ldapjdk</groupId>
             <artifactId>ldapjdk</artifactId>
             <scope>system</scope>
             <version>1.0</version>
             <systemPath>${basedir}\src\lib\ldapjdk.jar</systemPath>
</dependency>

Maven工程文档

在Demo项目目录下执行mvn site生成工程文档，打开 \demo\target\site 文件夹。点击 index.html 就可以看到文档了。

Maven工程模板

Maven - 工程模板

Maven 使用原型（Archetype）概念为用户提供了大量不同类型的工程模版（614 个）。Maven 使用下面的命令帮助用户快速创建 java 项目。

1
mvn archetype:generate

原型是一个 Maven 插件，它的任务是根据模板创建一个项目结构。我们将使用 quickstart 原型插件创建一个简单的 java 应用程序。

打开命令控制台，跳转到 \ MVN 目录并执行以下 mvn 命令

1
\MVN>mvn archetype:generate

Maven 将开始处理，并要求选择所需的原型

mvn compile与mvn install、mvn deploy的区别

  1. mvn compile，编译类文件
  2. mvn install，包含mvn compile，mvn package，然后上传到本地仓库
  3. mvn deploy,包含mvn install,然后，上传到本地仓库